Skip to main content

Update User Document

PUT : http://<base_url>/digipay/v3/user/user_document

This API is used to update new user extra field validation data into the system.

BODY PARAMS:-

ParameterTypeDescriptionValue
idstringa unique id assigned to user document to retrive user document detail5eeed854720d4730bff8b30a3fb5ed5e
document_user_typeIntit is an integer value which shows user_type where user_type can be customer,merchant and agent3
document_pathArrayRepresents the paths to document files. The example value is an empty list ([]) to be populated with actual paths.validation_key
document_statusIntIndicates the status of the document. The example value 1 could correspond to a certain status.1
document_type_idStringRepresents the unique identifier for the document type. The example value is a placeholder identifier.1bebc17c4a644333bec52534ddfe
user_idStringRepresents the unique identifier for the user. The example value is a placeholder identifier.1bebc17c4a644333bec52534ddfe
document_extra_fields_valuesarraryRepresents additional fields and values related to the document. The example value is an empty list ([]) to be populated with actual key-value pairs.
expiry_dateIntRepresents the expiration date of the document. The example value is calculated to be 24 hours from the current time in milliseconds."404 Not Found: The requested currency code does not exist.1679876400

HEADERS:-

ParameterTypeDescriptionValue
AuthorizationStringIt is a combination of type and token to authenticate user for the given tokenToken duik7309njdlkhdauhknksadhjkas986876sd873j
CompanyIDStringCompany_id is a unique primary id, that is represent company detail76bc712200ca444fa334f9e55e5fd7a8

Request Body:-

Request Example
curl --request PUT \
--url http://192.168.1.102:8014/digipay/v3/user/user_document \
--header 'Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NWY0ZDI1MDliZmU0NTBmYTg4MTVhNTU5Njk3YmM0NyIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNjkzNTIxOTU1fQ.9oWwUzlFzmYB1ZOhaVamxKJH6DsMO8tFue2kbg2YyoI' \
--header 'CompanyID: 76bc712200ca444fa334f9e55e5fd7a8' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"id": "5eeed854720d4730bff8b30a3fb5ed5e",
"document_user_type": 3,
"document_path": [
"[]"
],
"document_status": 1,
"document_type_id": "1bebc17c4a644333bec52534ddfe",
"user_id": "1bebc17c4a644333bec52534ddfe",
"document_extra_fields_values": [
"[]"
],
"expiry_date": 1679876400
}
'

Response:-

Response 200(OK)

{
"success": 1,
"error": [],
"data": {
"message": "Document data updated successfully."
}
}
Response 400(BAD REQUEST)
{
"success": 0,
"error"": [1],
"data": {
"message": "BAD_REQUEST",
}
}

RESPONSES :-

Status CodeDescription
200OK
400BAD REQUEST
404NOT FOUND
500INTERNAL SERVER ERROR